Consolidate integration tests for `EventCacheStore` by mgoldenberg · Pull Request #6061 · matrix-org/matrix-rust-sdk

mgoldenberg · 2026-01-26T00:49:56Z

Overview

There are a number of tests in the SQLite and IndexedDB implementations of the EventCacheStore which are general enough to be moved into the EventCacheStoreIntegrationTests trait. This pull request consolidates these tests to the extent possible.

Changes

Consolidating Tests

For existing test functions in matrix-sdk-sqlite::event_cache_store and matrix-sdk-indexeddb::event_cache_store, one of the following actions were taken.

None - the function tests only implementation-specific details and consequently could not be converted to a generalized integration test.
Copied - the function tests some implementation-specific details, but primarily interacts with the EventCacheStore trait, so it was converted into a generalized integration test and copied into the EventCacheStoreIntegrationTests trait.
Moved - the function does not test any implementation-specific details and only interacts with the EventCacheStore trait, so it was moved into the EventCacheStoreIntegrationTests trait.
Removed - the function tests properties that are already tested by other functions.

For the action taken for each existing function, see the tables at the end of this pull request.

Behavioral Inconsistencies

The process of converting existing tests into integration tests revealed that there were some behavioral differences between MemoryStore's implementation of EventCacheStore and other existing implementations - i.e., SQLiteEventCacheStore and IndexeddbEventCacheStore.

MemoryStore does not operate transactionally - i.e., a failure in a list of updates does not rollback previous updates in that list.
- This was handled by keeping tests of transactional operations in matrix_sdk_sqlite and matrix_sdk_indexeddb and documenting that MemoryStore does not operate transactionally.
MemoryStore does not allow referencing a chunk before it exists in the store - e.g., Update::NewItemsChunk::next may not provide a chunk identifier that is not in the store.
- This was handled by updating the logic of SQLiteEventCacheStore and IndexeddbEventCacheStore so that they too would not allow referencing a chunk before it exists in the store.
- A new integration test was added to ensure this functionality is working properly - i.e., test_linked_chunk_exists_before_referenced.
MemoryStore allows duplicate chunk identifiers - i.e., one can add a new chunk and assign it a chunk identifier that already exists in the store.
- This issue is outlined in MemoryStore allows duplicate ChunkIdentifier's #6095 and will likely be handled in a separate pull request.

Further Work

Since starting work on this pull request, some changes have been introduced to the SQLiteEventCacheStore (see #6065). These changes ensure that the SQLiteEventCacheStore can store the same event in multiple chunks and, furthermore, add a test to confirm this behavior.

These changes have not yet been applied to IndexeddbEventCacheStore (see #6094), so corresponding tests for these new behaviors could not be turned into integration tests yet.

Tables

`matrix-sdk-sqlite`

Test	Action
`test_pool_size`	None
`test_linked_chunk_new_items_chunk`	Removed
`test_linked_chunk_new_gap_chunk`	Removed
`test_linked_chunk_replace_item`	Moved
`test_linked_chunk_remove_chunk`	Copied
`test_linked_chunk_push_items`	Removed
`test_linked_chunk_remove_item`	Copied
`test_linked_chunk_detach_last_items`	Moved
`test_linked_chunk_start_end_reattach_items`	Moved
`test_linked_chunk_clear`	Copied
`test_linked_chunk_multiple_rooms`	Moved
`test_linked_chunk_update_is_a_transaction`	None
`test_filer_duplicate_events_no_events`	Moved
`test_load_last_chunk`	Moved
`test_load_last_chunk_with_a_cycle`	Moved
`test_load_previous_chunk`	Moved
`test_event_chunks_allows_same_event_in_room_and_thread`	None

`matrix-sdk-indexeddb`

Test	Action
`test_linked_chunk_new_items_chunk`	Removed
`test_add_gap_chunk_and_delete_immediately`	Removed
`test_linked_chunk_new_gap_chunk`	Removed
`test_linked_chunk_replace_item`	Moved
`test_linked_chunk_remove_chunk`	Copied
`test_linked_chunk_push_items`	Removed
`test_linked_chunk_remove_item`	Copied
`test_linked_chunk_detach_last_items`	Moved
`test_linked_chunk_start_end_reattach_items`	Moved
`test_linked_chunk_clear`	Copied
`test_linked_chunk_multiple_rooms`	Moved
`test_linked_chunk_update_is_a_transaction`	None
`test_load_last_chunk`	Moved
`test_load_previous_chunk`	Moved

Closes #5342.

Public API changes documented in changelogs (optional)

Signed-off-by: Michael Goldenberg m@mgoldenberg.net

… tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…ion tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…n tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

… tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…ests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…ation tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

… integration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…on tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…integration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…egration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…n tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

codspeed-hq · 2026-01-26T01:11:06Z

Merging this PR will not alter performance

✅ 50 untouched benchmarks

_{Comparing mgoldenberg:consolidate-event-cache-store-tests (f2abc55) with main (40c6c33)}

The tests removed are either covered by other tests or ensure properties that shouldn't exist - e.g., that new chunks can link to chunks that haven't been put into the store yet. Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

… store Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…rom integration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…to indexeddb tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

codecov · 2026-01-31T20:53:49Z

Codecov Report

❌ Patch coverage is 99.30556% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.82%. Comparing base (2f7887d) to head (f2abc55).
⚠️ Report is 71 commits behind head on main.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
crates/matrix-sdk-sqlite/src/event_cache_store.rs	88.23%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6061      +/-   ##
==========================================
- Coverage   89.84%   89.82%   -0.02%     
==========================================
  Files         362      362              
  Lines      100433    99931     -502     
  Branches   100433    99931     -502     
==========================================
- Hits        90230    89760     -470     
+ Misses       6678     6668      -10     
+ Partials     3525     3503      -22

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

…hunk Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

… integration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

andybalaam

This looks good to me, but I'd like @Hywan to take a quick look please!

Hywan

Excellent! Thank you for this great work. It was a long-standing issue, and clearly not so pleasant to do. I really appreciate the efforts here!

crates/matrix-sdk-indexeddb/src/event_cache_store/integration_tests.rs

crates/matrix-sdk-base/src/event_cache/store/integration_tests.rs

Hywan · 2026-02-05T08:01:33Z

crates/matrix-sdk-sqlite/src/event_cache_store.rs

+        if updated < 1 {
+            return Err(rusqlite::Error::QueryReturnedNoRows);
+        }
+        if updated > 1 {
+            return Err(rusqlite::Error::QueryReturnedMoreThanOneRow);
+        }


Hywan · 2026-02-05T08:01:57Z

crates/matrix-sdk-sqlite/src/event_cache_store.rs

+        if updated < 1 {
+            return Err(rusqlite::Error::QueryReturnedNoRows);
+        }
+        if updated > 1 {
+            return Err(rusqlite::Error::QueryReturnedMoreThanOneRow);
+        }


Hywan · 2026-02-05T08:03:28Z

crates/matrix-sdk-base/src/event_cache/store/memory_store.rs

+/// relevant when calling [`EventCacheStore::handle_linked_chunk_updates`],
+/// which consumes a list of [`Update`]s. When processing this list, if
+/// one of the [`Update`]s fails, the previous updates in the list
+/// will not be reversed.


Hywan · 2026-02-05T08:06:08Z

crates/matrix-sdk-common/src/linked_chunk/relational.rs

        linked_chunk_id: LinkedChunkId<'_>,
        updates: Vec<Update<Item, Gap>>,
-    ) {
+    ) -> Result<(), RelationalLinkedChunkError> {


Hywan · 2026-02-05T08:06:36Z

crates/matrix-sdk-base/src/event_cache/store/integration_tests.rs

        assert!(chunks.next().is_none());
    }

+    async fn test_linked_chunk_exists_before_referenced(&self) {


Great to have this test here now!

mgoldenberg added 16 commits January 25, 2026 17:26

test(event-cache): move test_linked_chunk_replace_item to integration…

680bc74

… tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_linked_chunk_new_items_chunk to integrat…

a7ab538

…ion tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_linked_chunk_new_gap_chunk to integratio…

ca9c74d

…n tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): copy test_linked_chunk_remove_chunk to integration…

cd1fbef

… tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_linked_chunk_push_items to integration t…

4f34b51

…ests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): copy test_linked_chunk_remove_item to integration …

2c8a915

…tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_linked_chunk_detach_last_items to integr…

fe1ab18

…ation tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_linked_chunk_start_end_reattach_items to…

d93238d

… integration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): copy test_linked_chunk_clear to integration tests

0443615

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_linked_chunk_multiple_rooms to integrati…

e60b204

…on tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): copy test_linked_chunk_update_is_a_transaction to …

3486701

…integration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_filter_duplicate_events_no_events to int…

750f59e

…egration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_load_last_chunk to integration tests

3738091

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_load_last_chunk_with_cycle to integratio…

12af5c4

…n tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_load_previous_chunk to integration tests

3c42e1b

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): remove extraneous tests from indexeddb impl

e128f0f

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

mgoldenberg added 8 commits January 30, 2026 13:42

feat(event-cache): ensure chunks exist before referenced in sqlite store

1b4e6aa

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

feat(event-cache): ensure chunks exist before referenced in indexeddb…

c641f5a

… store Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): remove test_linked_chunk_update_is_a_transaction f…

ab3995f

…rom integration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): restore test_linked_chunk_update_is_a_transaction …

d5de36b

…to indexeddb tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

doc(event-cache): document that MemoryStore is not transactional

3d32981

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

Merge branch 'main' into test-merge-consolidate-event-cache-store-tests

709d4cb

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

style(event-cache): fmt

78d681f

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

mgoldenberg added 4 commits February 3, 2026 10:43

feat(linked-chunk): add error type for relational linked chunk

f68696c

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

refactor(linked-chunk): use errors in RelationalLinkedChunk::insert_c…

ee1c95f

…hunk Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

feat(linked-chunk): use errors in RelationalLinkedChunk::apply_updates

d92b3ef

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

test(event-cache): move test_linked_chunk_exists_before_referenced to…

d6293c7

… integration tests Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

doc(event-cache): update relevant change logs

f2abc55

Signed-off-by: Michael Goldenberg <m@mgoldenberg.net>

mgoldenberg marked this pull request as ready for review February 3, 2026 17:16

mgoldenberg requested a review from a team as a code owner February 3, 2026 17:16

mgoldenberg requested review from andybalaam and removed request for a team February 3, 2026 17:16

andybalaam approved these changes Feb 4, 2026

View reviewed changes

andybalaam requested a review from Hywan February 4, 2026 11:02

Hywan approved these changes Feb 5, 2026

View reviewed changes

Hywan merged commit 2ff33cd into matrix-org:main Feb 5, 2026
55 of 60 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consolidate integration tests for `EventCacheStore`#6061

Consolidate integration tests for `EventCacheStore`#6061
Hywan merged 29 commits intomatrix-org:mainfrom
mgoldenberg:consolidate-event-cache-store-tests

mgoldenberg commented Jan 26, 2026 •

edited

Loading

Uh oh!

codspeed-hq bot commented Jan 26, 2026 •

edited

Loading

Uh oh!

codecov bot commented Jan 31, 2026 •

edited

Loading

Uh oh!

andybalaam left a comment

Uh oh!

Hywan left a comment

Uh oh!

Uh oh!

Uh oh!

Hywan Feb 5, 2026

Uh oh!

Hywan Feb 5, 2026

Uh oh!

Hywan Feb 5, 2026

Uh oh!

Hywan Feb 5, 2026

Uh oh!

Hywan Feb 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

mgoldenberg commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Changes

Consolidating Tests

Behavioral Inconsistencies

Further Work

Tables

matrix-sdk-sqlite

matrix-sdk-indexeddb

Uh oh!

codspeed-hq bot commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Uh oh!

codecov bot commented Jan 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

andybalaam left a comment

Choose a reason for hiding this comment

Uh oh!

Hywan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Hywan Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Hywan Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Hywan Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Hywan Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Hywan Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mgoldenberg commented Jan 26, 2026 •

edited

Loading

`matrix-sdk-sqlite`

`matrix-sdk-indexeddb`

codspeed-hq bot commented Jan 26, 2026 •

edited

Loading

codecov bot commented Jan 31, 2026 •

edited

Loading